Ink Events

Description

Ink events help define what should happen whenever certain events occur in an ink control. When an overlay is created a number of these events will be populated automatically; in order to define actions for the buttons that come with the overlay.

Name
Description
onInitialize

An event fired when Ink Control is initialized.

onChange

Event fired when a user edits Ink.

onBeforeCommit

Event fired before the Ink is committed.

onCommit

Event fired after the Ink is committed.

onToolChange

Event fired when the tool is changed. Event gets two arguments. The 'tool' is the current tool being used, and the 'old Tool' is the previous tool to be used. The onToolCHange event and be employed to set button states

onPenChange

Event fired when the pen is changed. The event gets 'pen' which contains the current pen settings. This can be used with A5.ink.penPreview() to create a preview of the current pen.

onBackgroundChange

Event fired when the background is changed. The event gets 'pen' which contains the current pen settings. This can be used with A5.ink.penPreview() to create a preview of the current pen.

onLayout

Event fired when the layout of the Ink control is updated.